<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN">
<html>
<head>
<title>DRV_I2C_TransferStatusGet Function</title>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <meta name="generator" content="Doc-O-Matic" />
    <meta http-equiv="Content-Style-Type" content="text/css" />
    <link rel="STYLESHEET" href="default.css" type="text/css" />

<script type="text/javascript" src="scripts.js"></script>
</head>
<body class="Element700" onload="onBodyLoadEx('frames.html', 'topic', '00279.html');" onmousedown="onBodyMouseDown();">

<!-- Begin Popups -->

<!-- End Popups -->

<!-- Begin Page Header -->
<div class="Element710" id="areafixed">
<div class="Element94">
<a href="00007.html" target="topic">Driver Libraries Help</a> &gt; <a href="00058.html" target="topic">I2C Driver Library Help</a> &gt; <a href="00059.html" target="topic">Library Interface</a> &gt; c) Data Transfer Functions &gt; <a href="00279.html" target="topic">DRV_I2C_TransferStatusGet Function</a></div>
<div class="Element92">
<table width="100%" cellspacing="0" cellpadding="0">
<tr><td width="25%">
<div class="Element1">
MPLAB Harmony Core Help</div>
</td><td width="25%">
<div class="Element2">
<a href="contents.html" target="tocidx">Contents</a> | <a href="00007.html" target="topic">Home</a></div>
</td><td width="25%">
<div class="Element90">
<a href="00281.html" target="topic">Previous</a> | <a href="00059.html" target="topic">Up</a> | <a href="00261.html" target="topic">Next</a></div>
</td><td width="25%">
<div class="Element96">
<a href="mailto:docerrors@microchip.com&subject=MPLAB Harmony Documentation Feedback (Topic ID: DRV_I2C_TransferStatusGet@DRV_I2C_TRANSFER_HANDLE Topic Title: DRV_I2C_TransferStatusGet Function)&body=Thank you for your feedback! Please include a description of your feedback, and indicate whether you are reporting an an error in the documentation or an enhancement.">Documentation Feedback</a><br> <a href="http://support.microchip.com" target="_blank">Microchip Support</a></div>
</td></tr></table><div class="Element5">
DRV_I2C_TransferStatusGet Function</div>
</div>
</div>

<!-- End Page Header -->

<!-- Begin Client Area -->
<div class="Element720" id="areascroll">
<div class="Element721">

<!-- Begin Page Content -->
<a name="PageContent"></a><div class="Element58">
<a name="4465736372697074696F6E"></a><div class="Element11">
<div class="Element10">
<p class="Element10">
This function can be used to poll the status of the queued transfer request if the application doesn't prefer to use the event handler (callback) function to get notified.</p></div>
</div>
<a name="43"></a><div class="Element99">
C</div>
<div class="Element101"><div class="Element100"><pre class="Element100"><a href="00268.html" target="topic">DRV_I2C_TRANSFER_EVENT</a> <strong><span style="color: #000000">DRV_I2C_TransferStatusGet</span></strong>(
    <strong><span style="color: #000080">const</span></strong> <a href="00275.html" target="topic">DRV_I2C_TRANSFER_HANDLE</a> <strong><span style="color: #000000">transferHandle</span></strong>
);</pre></div></div>
<a name="507265636F6E646974696F6E73"></a><div class="Element14">
Preconditions</div>
<div class="Element11">
<div class="Element10">
<p class="Element10">
<a href="00264.html" target="topic">DRV_I2C_Open</a> must have been called to obtain a valid opened device handle.&nbsp;</p>
<p class="Element10">
Either the <a href="00266.html" target="topic">DRV_I2C_ReadTransferAdd</a>, <a href="00283.html" target="topic">DRV_I2C_WriteTransferAdd</a> or <a href="00281.html" target="topic">DRV_I2C_WriteReadTransferAdd</a> function must have been called and a valid buffer handle returned.</p></div>
</div>
<a name="506172616D6574657273"></a><div class="Element14">
Parameters</div>
<div class="Element11">
<div class="Element10">
<div class="Element312">
<div class="TableDiv">
<table cellspacing="0" class="Table3">
<tr>
<td class="Element300" valign="top" width="35%">
<div class="Element301">
Parameters&nbsp;</div></td><td class="Element304" valign="top" width="65%">
<div class="Element305">
Description&nbsp;</div></td></tr><tr>
<td class="Element302" valign="top" width="35%">
<div class="Element303">
transferHandle&nbsp;</div></td><td class="Element306" valign="top" width="65%">
<div class="Element307">
Handle for the buffer of which the processed number of bytes to be obtained.&nbsp;</div></td></tr></table></div></div>
</div>
</div>
<a name="52657475726E73"></a><div class="Element14">
Returns</div>
<div class="Element11">
<div class="Element10">
<p class="Element10">
The success or error event of the transfer.</p></div>
</div>
<a name="52656D61726B73"></a><div class="Element14">
Remarks</div>
<div class="Element11">
<div class="Element10">
<p class="Element10">
This function is available only in the asynchronous mode.</p></div>
</div>
<a name="4578616D706C65"></a><div class="Element14">
Example</div>
<div class="Element11">
<div class="Element10">
<div class="Element13"><div class="Element12"><pre class="Element12">  uint8_t myBuffer[MY_BUFFER_SIZE];
  <a href="00275.html" target="topic">DRV_I2C_TRANSFER_HANDLE</a> transferHandle;
  <a href="00268.html" target="topic">DRV_I2C_TRANSFER_EVENT</a> event;

  <i><span style="color: #008000">// myI2CHandle is the handle returned</span></i>
  <i><span style="color: #008000">// by the DRV_I2C_Open function.</span></i>

  <a href="00266.html" target="topic">DRV_I2C_ReadTransferAdd</a>(myI2CHandle, slaveAddress, myBuffer, MY_BUFFER_SIZE, &amp;transferHandle);

  <strong><span style="color: #000080">if</span></strong>(transferHandle == <a href="00276.html" target="topic">DRV_I2C_TRANSFER_HANDLE_INVALID</a>)
  {
      <i><span style="color: #008000">// Error handling here</span></i>
  }

  <i><span style="color: #008000">//Check the status of the transfer</span></i>
  <i><span style="color: #008000">//This call can be used to wait until the transfer is processed.</span></i>

  event = DRV_I2C_TransferStatusGet(transferHandle);</pre></div></div>
</div>
</div>
</div>
<!-- End Page Content -->

<!-- Begin Page Footer -->
<div class="Element95">
<a href="00007.html" target="topic">Driver Libraries Help</a> &gt; <a href="00058.html" target="topic">I2C Driver Library Help</a> &gt; <a href="00059.html" target="topic">Library Interface</a> &gt; c) Data Transfer Functions &gt; <a href="00279.html" target="topic">DRV_I2C_TransferStatusGet Function</a></div>
<div class="Element93">
<table width="100%" cellspacing="0" cellpadding="0">
<tr><td width="25%">
<div class="Element3">
MPLAB Harmony Core Help</div>
</td><td width="25%">
<div class="Element4">
<a href="contents.html" target="tocidx">Contents</a> | <a href="00007.html" target="topic">Home</a></div>
</td><td width="25%">
<div class="Element91">
<a href="00281.html" target="topic">Previous</a> | <a href="00059.html" target="topic">Up</a> | <a href="00261.html" target="topic">Next</a></div>
</td><td width="25%">
<div class="Element97">
<a href="mailto:docerrors@microchip.com&subject=MPLAB Harmony Documentation Feedback (Topic ID: DRV_I2C_TransferStatusGet@DRV_I2C_TRANSFER_HANDLE Topic Title: DRV_I2C_TransferStatusGet Function)&body=Thank you for your feedback! Please include a description of your feedback, and indicate whether you are reporting an an error in the documentation or an enhancement.">Documentation Feedback</a><br> <a href="http://support.microchip.com" target="_blank">Microchip Support</a></div>
</td></tr></table></div>

<!-- End Page Footer -->
</div>
</div>

<!-- End Client Area -->
</body></html>